PE-6941 add description and keywords #25
Conversation
README.md
Outdated
| | Tag Name | Type | Pattern | Required | Description | | ||
| | ----------- | ------ | ----------------- | -------- | --------------------------------- | | ||
| | Action | string | "Set-Description" | true | Action tag for triggering handler | | ||
| | Description | string | N/A | true | New description for ANT. | |
There was a problem hiding this comment.
Pattern is 512 characters. Could specify utf-8 only but the limit is probably fine.
There was a problem hiding this comment.
Added 512 character pattern.
README.md
Outdated
| | Tag Name | Type | Pattern | Required | Description | | ||
| | -------- | ------ | -------------- | -------- | --------------------------------- | | ||
| | Action | string | "Set-Keywords" | true | Action tag for triggering handler | | ||
| | Keywords | table | "^[%w-_]+$" | true | New keywords for ANT. | |
There was a problem hiding this comment.
| | Keywords | table | "^[%w-_]+$" | true | New keywords for ANT. | | |
| | Keywords | table | "^[%w-_]{1,32}$" | true | New keywords for ANT. | |
There was a problem hiding this comment.
Consider allowing special characters - could allow integrations with apps that use # and @ for pointing to specific topics.
|
|
||
| #### `Set-Keywords` | ||
|
|
||
| Sets the keywords for the ANT. |
There was a problem hiding this comment.
worth mentioned max table size of 16 and min of 1
There was a problem hiding this comment.
Updated this to include that detail.
src/common/balances.lua
Outdated
|
|
||
| function balances.setKeywords(keywords) | ||
| assert(type(keywords) == "table", "Keywords must be an array") | ||
| assert(#keywords <= 16, "There must not be more than 16 keywords") |
There was a problem hiding this comment.
recommend add a check for the table containing atleast 1 keyword
There was a problem hiding this comment.
What if they want to empty their keywords?
src/common/initialize.lua
Outdated
| assert(type(keywords) == "table", "Keywords must be an array") | ||
| assert(#keywords <= 16, "There must not be more than 16 keywords") | ||
|
|
||
| local seenKeywords = {} | ||
| for _, keyword in ipairs(keywords) do | ||
| assert(type(keyword) == "string", "Each keyword must be a string") | ||
| assert(#keyword <= 32, "Each keyword must not be longer than 32 characters") | ||
| assert(not keyword:find("%s"), "Keywords must not contain spaces") | ||
| assert(keyword:match("^[%w-_]+$"), "Keywords must only contain alphanumeric characters, dashes, or underscores") | ||
| assert(not seenKeywords[keyword], "Duplicate keyword detected: " .. keyword) | ||
| seenKeywords[keyword] = true | ||
| end | ||
|
|
There was a problem hiding this comment.
this is all duplicate code, recommend pulling this out into a validation util and using here as well as in the setKeyword util
There was a problem hiding this comment.
Great point. Added utility function to validate keywords.
atticusofsparta
changed the title
atticusofsparta
force-pushed
the
PE-6941-add-description-and-keywords
branch
from
1585978 to
be0b48f
Compare
No description provided.